Class that represents the Wayland IVI EGL graphics output. More...

#include <kanzi/core.ui/platform/graphics_output/wayland_ivi_egl/wayland_ivi_egl_graphics_output.hpp>

Inheritance diagram for kanzi::wayland::WaylandIVIEGLGraphicsOutput:

Public Member Functions
void	bringLayerToFront () noexcept
	Brings the layer on top of all the other layers on a screen.

void	bringSurfaceToFront () noexcept
	Brings the surface on top of all the other surfaces in a layer.

bool	bringToFront () noexcept override
	WindowedGraphicsOutput::bringToFront() implementation.

bool	dispatch () const noexcept
	Dispatches queued Wayland events.

bool	dispatchPending () const noexcept
	Dispatches queued Wayland events.

void	eventNotification (const WaylandEvent &event) noexcept override
	AbstractDefaultWaylandContext::eventNotification() implementation.

void	gatherEvents (EventQueue &queue) override
	EventSource::gatherEvents() implementation.

KZ_NO_DISCARD int	getLayerPositionX () const noexcept
	Gets the X coordinate of a layer.

KZ_NO_DISCARD int	getLayerPositionY () const noexcept
	Gets the Y coordinate of a layer.

KZ_NO_DISCARD optional< NativeEventHandle >	getNativeEventHandle () const noexcept override
	WakeupSignalSource::getNativeEventHandle() implementation.

KZ_NO_DISCARD optional< NativeWindowHandle >	getNativeWindowHandle () const noexcept override
	WindowedGraphicsOutput::getNativeWindowHandle() implementation.

KZ_NO_DISCARD windowing::Size	getResolution () const noexcept
	Gets the resolution of a screen.

KZ_NO_DISCARD int	getSurfacePositionX () const noexcept
	Gets the X coordinate of a surface.

KZ_NO_DISCARD int	getSurfacePositionY () const noexcept
	Gets the Y coordinate of a surface.

KZ_NO_DISCARD Matrix4x4	getTargetTransformation () const noexcept override
	GLGraphicsOutput::getTargetTransformation() implementation.

KZ_NO_DISCARD const WaylandDisplay &	getWaylandDisplay () const noexcept
	Gets the WaylandDisplay.

KZ_NO_DISCARD vector< WaylandOutput > &	getWaylandOutputs () noexcept
	Gets Wayland outputs.

KZ_NO_DISCARD vector< WaylandSeat > &	getWaylandSeats () noexcept
	Gets Wayland seats.

KZ_NO_DISCARD optional< unsigned int >	getWindowHeight () const noexcept override
	WindowedGraphicsOutput::getWindowHeight() implementation.

KZ_NO_DISCARD optional< int >	getWindowPositionX () const noexcept override
	WindowedGraphicsOutput::getWindowPositionX() implementation.

KZ_NO_DISCARD optional< int >	getWindowPositionY () const noexcept override
	WindowedGraphicsOutput::getWindowPositionY() implementation.

KZ_NO_DISCARD optional< string >	getWindowTitle () const noexcept override
	WindowedGraphicsOutput::getWindowTitle() implementation.

KZ_NO_DISCARD optional< unsigned int >	getWindowWidth () const noexcept override
	WindowedGraphicsOutput::getWindowWidth() implementation.

void	hideLayer () noexcept
	Hides a layer.

void	hideSurface () noexcept
	Hides a surface.

bool	hideWindow () noexcept override
	WindowedGraphicsOutput::hideWindow() implementation.

bool	makeFullscreen () noexcept override
	WindowedGraphicsOutput::makeFullscreen() implementation.

void	makeLayerMaximized () noexcept
	Sets a layer to take up an entire screen.

bool	makeMaximized () noexcept override
	WindowedGraphicsOutput::makeMaximized() implementation.

bool	makeMinimized () noexcept override
	WindowedGraphicsOutput::makeMinimized() implementation.

bool	makeRegular () noexcept override
	WindowedGraphicsOutput::makeRegular() implementation.

void	makeSurfaceMaximized () noexcept
	Sets a surface to take up an entire layer.

void	modeChangeNotification (WaylandOutput::NativeHandleType nativeOutput, unsigned int flags, int width, int height, int refresh) noexcept override
	AbstractDefaultWaylandContext::modeChangeNotification() implementation.

void	moveLayer (int positionX, int positionY) noexcept
	Moves a layer to the specified coordinates.

void	moveSurface (int positionX, int positionY) noexcept
	Moves a surface to the specified coordinates.

bool	moveWindow (int positionX, int positionY) noexcept override
	WindowedGraphicsOutput::moveWindow() implementation.

WaylandIVIEGLGraphicsOutput &	operator= (const WaylandIVIEGLGraphicsOutput &)=delete
	Copy assignment operator.

WaylandIVIEGLGraphicsOutput &	operator= (WaylandIVIEGLGraphicsOutput &&) noexcept=delete
	Move assignment operator.

bool	registerFrameCallback (function< void()> &callback) noexcept
	Registers a frame callback in Wayland.

void	registryAddedNotification (uint32_t name, const char *interfaceName, uint32_t version) noexcept override
	AbstractDefaultWaylandContext::registryAddedNotification() implementation.

void	registryRemovedNotification (uint32_t name) noexcept override
	AbstractDefaultWaylandContext::registryRemovedNotification() implementation.

bool	resize (unsigned int width, unsigned int height) noexcept override
	WindowedGraphicsOutput::resize() implementation.

bool	resizeEGLWindow (int width, int height) noexcept
	Changes EGLWindow dimensions.

void	resizeIVILayer (int width, int height) noexcept
	Changes layer dimensions.

void	resizeIVIWMSurface (int width, int height) noexcept
	Changes surface dimensions.

void	resizeNotification (int windowWidth, int windowHeight) noexcept override
	AbstractDefaultWaylandContext::resizeNotification() implementation.

bool	resizeWindow (unsigned int width, unsigned int height) noexcept override
	WindowedGraphicsOutput::resizeWindow() implementation.

void	seatCapabilitiesNotification (WaylandSeat::NativeHandleType nativeSeat, uint32_t capabilities) noexcept override
	AbstractDefaultWaylandContext::seatCapabilitiesNotification() implementation.

bool	setAppId (string_view id) noexcept
	Sets the application ID.

void	setLayerOpacity (double opacity) noexcept
	Sets the opacity of a layer.

void	setSurfaceOpacity (double opacity) noexcept
	Sets the opacity of a surface.

bool	setWindowTitle (string_view title) noexcept override
	WindowedGraphicsOutput::setWindowTitle() implementation.

void	showLayer () noexcept
	Shows a layer.

void	showSurface () noexcept
	Shows a surface.

bool	showWindow () noexcept override
	WindowedGraphicsOutput::showWindow() implementation.

void	updateCache (int width, int height) noexcept
	Updates the target layout area size.

	WaylandIVIEGLGraphicsOutput (const WaylandIVIEGLGraphicsOutput &)=delete
	Copy constructor.

	WaylandIVIEGLGraphicsOutput (const WaylandIVIEGLGraphicsOutputProperties &properties)
	Constructor.

	WaylandIVIEGLGraphicsOutput (WaylandIVIEGLGraphicsOutput &&) noexcept=delete
	Move constructor.

	~WaylandIVIEGLGraphicsOutput () override
	Destructor.

Public Member Functions inherited from kanzi::GraphicsOutput
KZ_NO_DISCARD Vector2	getDpi () const noexcept
	Returns the resolution of the target coordinate system in dots per inch.

KZ_NO_DISCARD unsigned int	getHeight () const noexcept
	Returns the height of layout area in the target coordinate system.

KZ_NO_DISCARD unsigned int	getWidth () const noexcept
	Returns the width of layout area in the target coordinate system.

virtual	~GraphicsOutput ()=default
	Destructor.

Public Member Functions inherited from kanzi::EventSource
virtual	~EventSource ()=default
	Destructor.

Public Member Functions inherited from kanzi::WakeupSignalSource
WakeupSignalSource &	operator= (const WakeupSignalSource &)=default
	Copy assignment operator.

WakeupSignalSource &	operator= (WakeupSignalSource &&) noexcept=default
	Move assignment operator.

	WakeupSignalSource ()=default
	Constructor.

	WakeupSignalSource (const WakeupSignalSource &)=default
	Copy constructor.

	WakeupSignalSource (WakeupSignalSource &&) noexcept=default
	Move constructor.

virtual	~WakeupSignalSource ()=default
	Destructor.

Public Member Functions inherited from kanzi::FramebufferGraphicsOutput
	FramebufferGraphicsOutput ()
	Constructor.

KZ_NO_DISCARD const Framebuffer &	getFramebuffer () const noexcept
	Returns the framebuffer for the Graphics Output.

KZ_NO_DISCARD Framebuffer &	getFramebuffer () noexcept
	Returns the framebuffer for the Graphics Output.

virtual	~FramebufferGraphicsOutput ()=default
	Destructor.

Public Member Functions inherited from kanzi::WindowedGraphicsOutput
virtual	~WindowedGraphicsOutput ()=default
	Destructor.

Public Member Functions inherited from kanzi::wayland::AbstractDefaultWaylandContext
	AbstractDefaultWaylandContext ()=default
	Constructor.

	AbstractDefaultWaylandContext (AbstractDefaultWaylandContext &&) noexcept=delete
	Move constructor.

	AbstractDefaultWaylandContext (const AbstractDefaultWaylandContext &)=delete
	Copy constructor.

AbstractDefaultWaylandContext &	operator= (AbstractDefaultWaylandContext &&) noexcept=delete
	Move assignment operator.

AbstractDefaultWaylandContext &	operator= (const AbstractDefaultWaylandContext &)=delete
	Copy assignment operator.

virtual	~AbstractDefaultWaylandContext ()=default
	Destructor.

Additional Inherited Members
Protected Member Functions inherited from kanzi::GraphicsOutput
void	updateDpi (Vector2 dpi)
	Updates the target layout area resolution.

void	updateSize (unsigned int width, unsigned int height)
	Updates the target layout area size.

Detailed Description

Class that represents the Wayland IVI EGL graphics output.

Since: Kanzi 3.9.8; Kanzi 4.0.0 renamed from DefaultWaylandIVIEGLGraphicsOutput.

See also: AbstractDefaultWaylandContext for Wayland-specific callbacks.

Constructor & Destructor Documentation

◆ WaylandIVIEGLGraphicsOutput() [1/3]

kanzi::wayland::WaylandIVIEGLGraphicsOutput::WaylandIVIEGLGraphicsOutput ( const WaylandIVIEGLGraphicsOutputProperties & properties )

explicit

Constructor.

Parameters

properties Properties to request for the graphics output.

◆ ~WaylandIVIEGLGraphicsOutput()

kanzi::wayland::WaylandIVIEGLGraphicsOutput::~WaylandIVIEGLGraphicsOutput ( )

override

Destructor.

◆ WaylandIVIEGLGraphicsOutput() [2/3]

kanzi::wayland::WaylandIVIEGLGraphicsOutput::WaylandIVIEGLGraphicsOutput ( const WaylandIVIEGLGraphicsOutput & )

delete

Copy constructor.

◆ WaylandIVIEGLGraphicsOutput() [3/3]

kanzi::wayland::WaylandIVIEGLGraphicsOutput::WaylandIVIEGLGraphicsOutput ( WaylandIVIEGLGraphicsOutput && )

deletenoexcept

Move constructor.

Member Function Documentation

◆ updateCache()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::updateCache	(	int	width,
		int	height )

noexcept

Updates the target layout area size.

Parameters

width	The layout width in pixels.
height	The layout height in pixels.

◆ resizeNotification()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::resizeNotification	(	int	windowWidth,
		int	windowHeight )

overridevirtualnoexcept

AbstractDefaultWaylandContext::resizeNotification() implementation.

Implements kanzi::wayland::AbstractDefaultWaylandContext.

◆ modeChangeNotification()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::modeChangeNotification	(	WaylandOutput::NativeHandleType	nativeOutput,
		unsigned int	flags,
		int	width,
		int	height,
		int	refresh )

overridevirtualnoexcept

AbstractDefaultWaylandContext::modeChangeNotification() implementation.

Implements kanzi::wayland::AbstractDefaultWaylandContext.

◆ eventNotification()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::eventNotification ( const WaylandEvent & event )

overridevirtualnoexcept

AbstractDefaultWaylandContext::eventNotification() implementation.

Implements kanzi::wayland::AbstractDefaultWaylandContext.

◆ seatCapabilitiesNotification()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::seatCapabilitiesNotification	(	WaylandSeat::NativeHandleType	nativeSeat,
		uint32_t	capabilities )

overridevirtualnoexcept

AbstractDefaultWaylandContext::seatCapabilitiesNotification() implementation.

Implements kanzi::wayland::AbstractDefaultWaylandContext.

◆ registryAddedNotification()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::registryAddedNotification	(	uint32_t	name,
		const char *	interfaceName,
		uint32_t	version )

overridevirtualnoexcept

AbstractDefaultWaylandContext::registryAddedNotification() implementation.

Implements kanzi::wayland::AbstractDefaultWaylandContext.

◆ registryRemovedNotification()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::registryRemovedNotification ( uint32_t name )

overridevirtualnoexcept

AbstractDefaultWaylandContext::registryRemovedNotification() implementation.

Since: Kanzi 4.0.0

Implements kanzi::wayland::AbstractDefaultWaylandContext.

◆ gatherEvents()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::gatherEvents ( EventQueue & queue )

overridevirtual

EventSource::gatherEvents() implementation.

Implements kanzi::EventSource.

◆ getNativeEventHandle()

KZ_NO_DISCARD optional< NativeEventHandle > kanzi::wayland::WaylandIVIEGLGraphicsOutput::getNativeEventHandle ( ) const

overridevirtualnoexcept

WakeupSignalSource::getNativeEventHandle() implementation.

Implements kanzi::WakeupSignalSource.

◆ getTargetTransformation()

KZ_NO_DISCARD Matrix4x4 kanzi::wayland::WaylandIVIEGLGraphicsOutput::getTargetTransformation ( ) const

overridevirtualnoexcept

GLGraphicsOutput::getTargetTransformation() implementation.

Implements kanzi::FramebufferGraphicsOutput.

◆ setWindowTitle()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::setWindowTitle ( string_view title )

overridevirtualnoexcept

WindowedGraphicsOutput::setWindowTitle() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ setAppId()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::setAppId ( string_view id )

noexcept

Sets the application ID.

Parameters

id	Application ID to set.

Returns: When the function successfully sets the application ID, true, otherwise false.

Since: Kanzi 4.0.0

◆ getWindowTitle()

KZ_NO_DISCARD optional< string > kanzi::wayland::WaylandIVIEGLGraphicsOutput::getWindowTitle ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowTitle() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ resize()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::resize	(	unsigned int	width,
		unsigned int	height )

overridevirtualnoexcept

WindowedGraphicsOutput::resize() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ resizeWindow()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::resizeWindow	(	unsigned int	width,
		unsigned int	height )

overridevirtualnoexcept

WindowedGraphicsOutput::resizeWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ resizeIVILayer()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::resizeIVILayer	(	int	width,
		int	height )

noexcept

Changes layer dimensions.

When resizing, keep in mind that:

IviScreen boundaries crop output of an IVILayer.
IviLayer boundaries crop output of an IVIWMSurface.
IviWmSurface boundaries crop output of a WaylandEGLWindow.

Parameters

width	New layer width.
height	New layer height.

◆ resizeIVIWMSurface()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::resizeIVIWMSurface	(	int	width,
		int	height )

noexcept

Changes surface dimensions.

When resizing, keep in mind that:

IviScreen boundaries crop output of an IVILayer.
IviLayer boundaries crop output of an IVIWMSurface.
IviWmSurface boundaries crop output of a WaylandEGLWindow.

Parameters

width	New surface width.
height	New surface height.

◆ resizeEGLWindow()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::resizeEGLWindow	(	int	width,
		int	height )

noexcept

Changes EGLWindow dimensions.

When resizing, keep in mind that:

IviScreen boundaries crop output of an IVILayer.
IviLayer boundaries crop output of an IVIWMSurface.
IviWmSurface boundaries crop output of a WaylandEGLWindow.

Parameters

width	New EGLWindow width.
height	New EGLWindow height.

◆ getWindowWidth()

KZ_NO_DISCARD optional< unsigned int > kanzi::wayland::WaylandIVIEGLGraphicsOutput::getWindowWidth ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowWidth() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowHeight()

KZ_NO_DISCARD optional< unsigned int > kanzi::wayland::WaylandIVIEGLGraphicsOutput::getWindowHeight ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowHeight() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ moveWindow()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::moveWindow	(	int	positionX,
		int	positionY )

overridevirtualnoexcept

WindowedGraphicsOutput::moveWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ moveLayer()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::moveLayer	(	int	positionX,
		int	positionY )

noexcept

Moves a layer to the specified coordinates.

Parameters

positionX	X coordinate.
positionY	Y coordintate.

◆ moveSurface()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::moveSurface	(	int	positionX,
		int	positionY )

noexcept

Moves a surface to the specified coordinates.

Parameters

positionX	X coordinate.
positionY	Y coordintate.

◆ getWindowPositionX()

KZ_NO_DISCARD optional< int > kanzi::wayland::WaylandIVIEGLGraphicsOutput::getWindowPositionX ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowPositionX() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getWindowPositionY()

KZ_NO_DISCARD optional< int > kanzi::wayland::WaylandIVIEGLGraphicsOutput::getWindowPositionY ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getWindowPositionY() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ getLayerPositionX()

KZ_NO_DISCARD int kanzi::wayland::WaylandIVIEGLGraphicsOutput::getLayerPositionX ( ) const

noexcept

Gets the X coordinate of a layer.

Returns: X coordinate of a layer.

◆ getLayerPositionY()

KZ_NO_DISCARD int kanzi::wayland::WaylandIVIEGLGraphicsOutput::getLayerPositionY ( ) const

noexcept

Gets the Y coordinate of a layer.

Returns: Y coordinate of a layer.

◆ getSurfacePositionX()

KZ_NO_DISCARD int kanzi::wayland::WaylandIVIEGLGraphicsOutput::getSurfacePositionX ( ) const

noexcept

Gets the X coordinate of a surface.

Returns: X coordinate of a surface.

◆ getSurfacePositionY()

KZ_NO_DISCARD int kanzi::wayland::WaylandIVIEGLGraphicsOutput::getSurfacePositionY ( ) const

noexcept

Gets the Y coordinate of a surface.

Returns: Y coordinate of a surface.

◆ makeFullscreen()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::makeFullscreen ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeFullscreen() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeRegular()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::makeRegular ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeRegular() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeMaximized()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::makeMaximized ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeMaximized() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ makeLayerMaximized()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::makeLayerMaximized ( )

noexcept

Sets a layer to take up an entire screen.

◆ makeSurfaceMaximized()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::makeSurfaceMaximized ( )

noexcept

Sets a surface to take up an entire layer.

◆ makeMinimized()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::makeMinimized ( )

overridevirtualnoexcept

WindowedGraphicsOutput::makeMinimized() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ showWindow()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::showWindow ( )

overridevirtualnoexcept

WindowedGraphicsOutput::showWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ showLayer()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::showLayer ( )

noexcept

Shows a layer.

See also: showWindow()

◆ showSurface()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::showSurface ( )

noexcept

Shows a surface.

See also: showSurface()

◆ hideWindow()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::hideWindow ( )

overridevirtualnoexcept

WindowedGraphicsOutput::hideWindow() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ hideLayer()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::hideLayer ( )

noexcept

Hides a layer.

See also: hideWindow()

◆ hideSurface()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::hideSurface ( )

noexcept

Hides a surface.

See also: hideWindow()

◆ bringToFront()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::bringToFront ( )

overridevirtualnoexcept

WindowedGraphicsOutput::bringToFront() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ bringLayerToFront()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::bringLayerToFront ( )

noexcept

Brings the layer on top of all the other layers on a screen.

◆ bringSurfaceToFront()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::bringSurfaceToFront ( )

noexcept

Brings the surface on top of all the other surfaces in a layer.

◆ setLayerOpacity()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::setLayerOpacity ( double opacity )

noexcept

Sets the opacity of a layer.

Parameters

opacity Layer opacity.

◆ setSurfaceOpacity()

void kanzi::wayland::WaylandIVIEGLGraphicsOutput::setSurfaceOpacity ( double opacity )

noexcept

Sets the opacity of a surface.

Parameters

opacity Surface opacity.

◆ registerFrameCallback()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::registerFrameCallback ( function< void()> & callback )

noexcept

Registers a frame callback in Wayland.

The best way to organize a rendering loop in Wayland is to let the compositor control when it is time to render a frame. To do this, use this function to register a frame callback that compositor calls for each frame.

Using Wayland rendering loop allows to save computer resources if compositor determines that your application must be rendered at lower refresh rate or not rendered. For example, when the application is off-screen or minimized.

Keep in mind that Wayland controls when the rendering occurs. Do not make any assumptions about the time between frames.

Parameters

callback Callback function to call each frame.

Returns: On success, true, otherwise false.

◆ dispatch()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::dispatch ( ) const

noexcept

Dispatches queued Wayland events.

If no events are queued, this operation blocks until the next event occurs.

Returns: On success, true, otherwise false.

See also: WaylandDisplay::dispatch()

◆ dispatchPending()

bool kanzi::wayland::WaylandIVIEGLGraphicsOutput::dispatchPending ( ) const

noexcept

Dispatches queued Wayland events.

If no events are queued, this operation returns without blocking.

Returns: On success, true, otherwise false.

See also: WaylandDisplay::dispatchPending()

◆ getResolution()

KZ_NO_DISCARD windowing::Size kanzi::wayland::WaylandIVIEGLGraphicsOutput::getResolution ( ) const

noexcept

Gets the resolution of a screen.

Returns: Screen resolution.

◆ getWaylandOutputs()

KZ_NO_DISCARD vector< WaylandOutput > & kanzi::wayland::WaylandIVIEGLGraphicsOutput::getWaylandOutputs ( )

noexcept

Gets Wayland outputs.

You can use this function to configure which Wayland outputs Kanzi uses.

For example of use, see getWaylandSeats().

Returns: Vector of listened Wayland outputs.

Since: Kanzi 4.0.0

◆ getWaylandSeats()

KZ_NO_DISCARD vector< WaylandSeat > & kanzi::wayland::WaylandIVIEGLGraphicsOutput::getWaylandSeats ( )

noexcept

Gets Wayland seats.

You can use this function to configure which Wayland seats Kanzi uses.

Example

// Do not process events from the first wl_seat.
auto wlGo = getGraphicsOutput<wayland::WaylandIVIEGLGraphicsOutput>(0);
kzAssert(wlGo);
 
auto& wlSeats = wlGo->getWaylandSeats();
wlSeats.erase(wlSeats.begin());

Returns: Vector of listened Wayland seats.

Since: Kanzi 4.0.0

◆ getWaylandDisplay()

KZ_NO_DISCARD const WaylandDisplay & kanzi::wayland::WaylandIVIEGLGraphicsOutput::getWaylandDisplay ( ) const

noexcept

Gets the WaylandDisplay.

Returns: Wayland display used by this GraphicsOutput.

◆ getNativeWindowHandle()

KZ_NO_DISCARD optional< NativeWindowHandle > kanzi::wayland::WaylandIVIEGLGraphicsOutput::getNativeWindowHandle ( ) const

overridevirtualnoexcept

WindowedGraphicsOutput::getNativeWindowHandle() implementation.

Implements kanzi::WindowedGraphicsOutput.

◆ operator=() [1/2]

WaylandIVIEGLGraphicsOutput & kanzi::wayland::WaylandIVIEGLGraphicsOutput::operator= ( const WaylandIVIEGLGraphicsOutput & )

delete

Copy assignment operator.

◆ operator=() [2/2]

WaylandIVIEGLGraphicsOutput & kanzi::wayland::WaylandIVIEGLGraphicsOutput::operator= ( WaylandIVIEGLGraphicsOutput && )

deletenoexcept

Move assignment operator.

The documentation for this class was generated from the following file:

kanzi/core.ui/platform/graphics_output/wayland_ivi_egl/wayland_ivi_egl_graphics_output.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WaylandIVIEGLGraphicsOutput() [1/3]

◆ ~WaylandIVIEGLGraphicsOutput()

◆ WaylandIVIEGLGraphicsOutput() [2/3]

◆ WaylandIVIEGLGraphicsOutput() [3/3]

Member Function Documentation

◆ updateCache()

◆ resizeNotification()

◆ modeChangeNotification()

◆ eventNotification()

◆ seatCapabilitiesNotification()

◆ registryAddedNotification()

◆ registryRemovedNotification()

◆ gatherEvents()

◆ getNativeEventHandle()

◆ getTargetTransformation()

◆ setWindowTitle()

◆ setAppId()

◆ getWindowTitle()

◆ resize()

◆ resizeWindow()

◆ resizeIVILayer()

◆ resizeIVIWMSurface()

◆ resizeEGLWindow()

◆ getWindowWidth()

◆ getWindowHeight()

◆ moveWindow()

◆ moveLayer()

◆ moveSurface()

◆ getWindowPositionX()

◆ getWindowPositionY()

◆ getLayerPositionX()

◆ getLayerPositionY()

◆ getSurfacePositionX()

◆ getSurfacePositionY()

◆ makeFullscreen()

◆ makeRegular()

◆ makeMaximized()

◆ makeLayerMaximized()

◆ makeSurfaceMaximized()

◆ makeMinimized()

◆ showWindow()

◆ showLayer()

◆ showSurface()

◆ hideWindow()

◆ hideLayer()

◆ hideSurface()

◆ bringToFront()

◆ bringLayerToFront()

◆ bringSurfaceToFront()

◆ setLayerOpacity()

◆ setSurfaceOpacity()

◆ registerFrameCallback()

◆ dispatch()

◆ dispatchPending()

◆ getResolution()

◆ getWaylandOutputs()

◆ getWaylandSeats()

Example

◆ getWaylandDisplay()

◆ getNativeWindowHandle()

◆ operator=() [1/2]

◆ operator=() [2/2]